atomist / sdm-core

Event-based implementation of an SDM, which subscribes to Atomist GraphQL
Apache License 2.0
6 stars 3 forks source link

SDM `name` not used for registration when passed as `ConfigureMachineOptions`, but is when set in `preProcessors` #243

Closed XertroV closed 4 years ago

XertroV commented 4 years ago

Please disregard if this has been fixed already.

in index.ts (if using v1.8.0 at least) when returning a configuration with an SDM name as part of ConfigureMachineOptions, the SDM will still be registered under the package name, not the specified name:

export const configuration = configure<FluxGoals>(configurer, { name: "some-sdm-name" });

However, the following will register under the specified name:

export const configuration = configure<FluxGoals>(configurer, { preProcessors: [
  async (opts) => {
    opts.name = "some name";
    return opts;
  }
] });

Examples

Example configuration and commit: https://github.com/XertroV/sdm-everything/blob/6fa53822f066c7596fe991750d6ec69a7cf5421d/index.ts#L216 (note: see readme for install instructions)

Good: Not passed as options.name, but set in preProcessor

Correctly shows up in dashboard as sdm-flux-aws

2020-06-14T21:20:10.863Z [m:2091744] [info ] Finished setting up goal configuration.
2020-06-14T21:20:10.899Z [m:2091744] [info ] Starting Atomist automation client sdm-flux-aws:0.2.0
2020-06-14T21:20:15.651Z [m:2091744] [info ] 
          _                     __  _                                           
 ___   __| | _ __ ___          / _|| | _   _ __  __         __ _ __      __ ___ 
/ __| / _` || '_ ` _ \  _____ | |_ | || | | |\ \/ / _____  / _` |\ \ /\ / // __|
\__ \| (_| || | | | | ||_____||  _|| || |_| | >  < |_____|| (_| | \ V  V / \__ \
|___/ \__,_||_| |_| |_|       |_|  |_| \__,_|/_/\_\        \__,_|  \_/\_/  |___/

  Version 0.2.0  Sha 450b783  Repository git@github.com:xertrov/sdm-everything.git
  Workspaces AMQ95ELE5, A6IA2BL5O  Policy ephemeral  Cluster disabled  Environment local

[... snip ...]

  Logging
    Console info
    File debug  Location log/sdm-flux-aws.log

  SDM
    sdm-flux-aws

  Extension Packs
    @atomist/sdm-core:info:1.8.0  by Atomist
    @atomist/sdm-core:job:1.8.0  by Atomist

[... snip]

Bad: Passed as options.name, not set in preProcessor

Shows up in dashboard as sdm-everything (should be sdm-flux-android-build)

2020-06-14T21:20:28.520Z [m:2091796] [info ] Finished setting up goal configuration.
2020-06-14T21:20:28.555Z [m:2091796] [info ] Starting Atomist automation client sdm-everything:0.2.0
2020-06-14T21:20:32.729Z [m:2091796] [info ] 
          _                                                    _    _      _               
 ___   __| | _ __ ___           ___ __   __  ___  _ __  _   _ | |_ | |__  (_) _ __    __ _ 
/ __| / _` || '_ ` _ \  _____  / _ \\ \ / / / _ \| '__|| | | || __|| '_ \ | || '_ \  / _` |
\__ \| (_| || | | | | ||_____||  __/ \ V / |  __/| |   | |_| || |_ | | | || || | | || (_| |
|___/ \__,_||_| |_| |_|        \___|  \_/   \___||_|    \__, | \__||_| |_||_||_| |_| \__, |
                                                        |___/                        |___/ 

  Version 0.2.0  Sha 450b783  Repository git@github.com:xertrov/sdm-everything.git
  Workspaces AMQ95ELE5, A6IA2BL5O  Policy ephemeral  Cluster disabled  Environment local

[... snip ...]

  Logging
    Console info
    File debug  Location log/sdm-everything.log

  SDM
    sdm-flux-android-build

  Extension Packs
    @atomist/sdm-core:info:1.8.0  by Atomist
    @atomist/sdm-core:job:1.8.0  by Atomist

[... snip]
atomist[bot] commented 4 years ago

Thanks for your contribution!

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

ddgenome commented 4 years ago

This should be fixed in SDM 2.0