userver-framework / service_template Goto Github PK

When trying to install userver/service_template on MacOS there are couple of issues:

1. Configure and Build.

The path third_party/userver/scripts/docs/en/deps/macos.md - simply doesn't exist and we should create macos.md file and copy-paste dependencies from here macos.html. Only after that we can use the mentioned command in documentation: brew install $(cat path/to/macos.md | tr '\n' ' ').

After the first step we should be aware that http-parser - is disabled and we cannot install it by brew or macport. We should go to this repo: https://github.com/nodejs/http-parser and clone it.
Steps after the cloning: cd http-parser and try make install. There's an issue that on MacOS there's no flag -D for install command. So we can replace it by -c, because we are moving files, not directories. After that make install should work and give us the lib.

Other dependencies, that not mentioned.

2. Build and Run

Issue found here.

This command will not work because of the lacking userver-samples-hello_service target on Makefile.

mkdir build_release
cd build_release
cmake -DCMAKE_BUILD_TYPE=Release ..
make userver-samples-hello_service

I've fixed it by reading Makefile and finding similar target: make start-service_template or make service_template.

But after that this command will not work also (maybe it was issue only in my mac, don't really know)
./samples/hello_service/userver-samples-hello_service -c </path/to/static_config.yaml>
Given static_config.yaml won't be parsed, because of the newlines between fields and non initialized variables such as worker-threads or ports.

I fixed it in static_config.yaml in this way:

components_manager:
    task_processors:                  # Task processor is an executor for coroutine tasks
        main-task-processor:          # Make a task processor for CPU-bound coroutine tasks.
            worker_threads: 4         # Process tasks in 4 threads.
        fs-task-processor:            # Make a separate task processor for filesystem bound tasks.
            worker_threads: 1
    default_task_processor: main-task-processor
    components:                       # Configuring components that were registered via component_list
        server:
            listener:                 # configuring the main listening socket...
                port: 80            # ...to listen on this port and...
                task_processor: main-task-processor    # ...process incoming requests on this task processor.

And after all everything will compile and work well. I hope this issue will help someone and I didn't miss anything.

OS: Ubuntu 22

'''
Unhandled exception in components::Run: Error while parsing configs from file '/home/user/.local/etc/service_template/static_config.yaml'. Details: Field 'components_manager.task_processors.main-task-processor.worker_threads' is missing
make: *** [Makefile:81: --in-docker-start-release] Error 1
make: *** [Makefile:88: docker-start-service-release] Error 2
'''

Encountered issue while using template:

make test-debug
...
pycodestyle tests
make: pycodestyle: No such file or directory
make: *** [Makefile:40: test-debug] Error 127
...

pycodestyle used in makefile, but not specified as a dependency.

Doesn't work on macOS with CLang compiler, produces following CMake error (CMakeError.log) attached as well:

cmake ..
-- C compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/cc
-- C++ compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/c++
-- Forcing warnings as errors!
-- Custom linker isn't available, using the default system linker.
-- LTO: on
-- LTO_CACHE enabled, cache folder is /Users/dev/Projects/GitHub/service_template/build/.ltocache
-- Looking for C++ include string
-- Looking for C++ include string - not found
CMake Error at third_party/userver/cmake/RequireLTO.cmake:31 (message):
LTO fails to compile a trivial program. See error logs for info. Try
specifying another linker via USERVER_USE_LD or changing the CMAKE_AR,
CMAKE_RANLIB, CMAKE_EXE_LINKER_FLAGS CMAKE_SHARED_LINKER_FLAGS
Call Stack (most recent call first):
CMakeError.log

third_party/userver/cmake/SetupLTO.cmake:22 (include)
third_party/userver/cmake/SetupEnvironment.cmake:44 (include)
CMakeLists.txt:4 (include)