update the pokemonsync flow.md

Update the pokemonSync flow

You have access to the newly created slack_user and pokemon_type configs. Let's update pokemonSync to make use of them.

The Pokémon Trainer Academy needs the new pokemonSync to do the following:

To do this we will need to:

  1. In the .env update the run mode and enter selections for the two dynamic configs:
   PAN_CTX_RUN_MODE= normal
   PAN_CFG_POKEMON_TYPE = rock
   PAN_CFG_SLACK_USER= <YOUR-SLACK-MEMBER-ID>

In the config object of your tenant's most recent normal sync logs you should have seen your Slack user ID. Replace the Slack user ID above with your own.

  1. Fetch the selected Pokémon type by doing the following:
    • In src/index.ts pass the config to pokemonSync.
    • In src/processLogic/pokemonSync.ts add config as an argument to pokemonSync and import Config to define the type of this new argument.
    • Pass config.pokemon_type to the pokeClient.getTypeByName method to fetch the selected type.
    • Log out the results of that fetch.

The pokemonSync.ts file should look something like this:

   import Pokedex from 'pokedex-promise-v2'
   import { WebClient } from '@slack/web-api'
   import { pokemonToSlackMessage } from '../transformations.js'
   import { Context, Config } from '../lib.js'

export const pokemonSync = async (
       pokeClient: Pokedex,
       slackClient: WebClient,
       context: Context,
       config: Config
   ) => {
       console.error(
           '------------------------POKEMON SYNC------------------------'
       )

const pokemonType = await pokeClient.getTypeByName(config.pokemon_type)
       console.error(pokemonType)

let lastPokemonId = 0
       if (context.last_successful_run_std_out) {
           const lastStdOut = JSON.parse(context.last_successful_run_std_out)
           lastPokemonId = Number(lastStdOut.last_pokemon_id) || 0
       }

const nextPokemonId = lastPokemonId + 1
       const pokemonOfTheDay = await pokeClient.getPokemonByName(nextPokemonId)

const slackMemberIds = ['<YOUR-SLACK-MEMBER-ID>']

for (const slackID of slackMemberIds) {
           const slackMessage = pokemonToSlackMessage(pokemonOfTheDay, slackID)
           await slackClient.chat.postMessage(slackMessage)
       }

return { last_pokemon_id: nextPokemonId }
   }
  1. Run npm run build && npm run start.

You should get a Pokémon Slack message, but we're more interested in examining the logs; they should look something like this:

   > pokemon-of-the-day@1.0.0 start
   > node build/src/

This run is in mode: normal
   ------------------------CONFIG------------------------
   Config { pokemon_type: 'rock', slack_user: '<YOUR-SLACK-MEMBER-ID>' }
   ------------------------CONTEXT------------------------
   Context {
     run_mode: 'normal',
     last_successful_run_std_out: '{"last_pokemon_id":247}'
   }
   ------------------------POKEMON SYNC------------------------
   {
     damage_relations: {... various damage relations properties of the rock Pokémon type}
     ... more properties of the rock Pokémon type
   }
   {"last_pokemon_id":248}

You can remove the console.error(pokemonType).

You can learn about the shape of a Pokémon type by examining the one you just logged out or reviewing the PokéAPI docs for the type endpoint.

You'll see that each Pokémon type has the property pokemon; it's an array of the type's Pokémon. We should select the Pokémon of the day from that list!

Each member of the pokemon array has the following shape:

   {
     "slot": 1,
     "pokemon": {
       "name": "sandshrew",
       "url": "https://pokeapi.co/api/v2/pokemon/27/"
     }
   }
  1. Change how nextPokemonId is defined; it should be the ID of the first member of the fetched type's pokemon array whose ID is greater than lastPokemonId.

Here is one way you could do this:

const pokemonType = await pokeClient.getTypeByName(config.pokemon_type) const pokemonOptions = pokemonType.pokemon

let nextPokemonId: string | undefined for (const pokemon of pokemonOptions) { const pokemonId = Number(pokemon.pokemon.url.split('/').slice(-2, -1)[0]) if (pokemonId <= lastPokemonId) continue nextPokemonId = String(pokemonId) break } if(!nextPokemonId) return {last_pokemon_id: lastPokemonId }

   const pokemonOfTheDay = await pokeClient.getPokemonByName(nextPokemonId)

const slackMemberIds = ['']

for (const slackID of slackMemberIds) { const slackMessage = pokemonToSlackMessage(pokemonOfTheDay, slackID) await slackClient.chat.postMessage(slackMessage) }

return { last_pokemon_id: nextPokemonId } }


5. Run `npm run build && npm run start`.

Unless you changed the standard out in your .env this run's results may not look too different from the last run's (except the logs won't include the Pokémon type). This is because the list of Pokémon within a type often has many Pokémon of consecutive IDs. Regardless, you have shown that the new method of defining `nextPokemonId` does not interfere with the rest of the flow's functionality.

6. Now adjust pokemonSync to use the `slack_user` config
* [ ] Remove the array of hard coded `slackMemberIds`.
* [ ] Instead of sending a Slack message for every member in that array just pass `config.slack_user` to `pokemonToSlackMessage`, and only call `slackClient.chat.postMessage` for that one `slackMessage.`

Your `pokemonSync.ts` could look like this now:

const pokemonType = await pokeClient.getTypeByName(config.pokemon_type)
    const pokemonOptions = pokemonType.pokemon

let nextPokemonId: string | undefined
    for (const pokemon of pokemonOptions) {
        const pokemonId = Number(pokemon.pokemon.url.split('/').slice(-2, -1)[0])
        if (pokemonId <= lastPokemonId) continue
        nextPokemonId = String(pokemonId)
        break
    }
    if(!nextPokemonId) return {last_pokemon_id: lastPokemonId }

const pokemonOfTheDay = await pokeClient.getPokemonByName(nextPokemonId)

const slackMessage = pokemonToSlackMessage(pokemonOfTheDay, config.slack_user)
    await slackClient.chat.postMessage(slackMessage)
    
    return { last_pokemon_id: nextPokemonId }
}
  1. Run npm run build && npm run start.

Once again, this run's results may not look too different from the last run's. This shows that accessing the slack User's ID from config, instead of a hardcoded list does not interfere with the rest of the flow's functionality.

Your pokemonSync.ts should match this one. In fact your integration files should match all the ones in this repository.

The final step is to see what this all looks like when it is run on Pandium!