Create a function to get the public options for an InteractiveGraph widget

[benchristel]

Issue: https://khanacademy.atlassian.net/browse/LEMS-2755

Test plan:

yarn test

[github-actions]

npm Snapshot: Published

Good news!! We've packaged up the latest commit from this PR (a3e2ddd) and published it to npm. You
can install it using the tag PR2194.

Example:

yarn add @khanacademy/perseus@PR2194

If you are working in Khan Academy's webapp, you can run:

./dev/tools/bump_perseus_version.sh -t PR2194

[github-actions]

Size Change: +46 B (0%)

Total Size: 1.48 MB

Filename	Size	Change
packages/perseus-core/dist/es/index.js	46.3 kB	+32 B (+0.07%)
packages/perseus/dist/es/index.js	378 kB	+14 B (0%)

ℹ️ View Unchanged

Filename	Size
packages/kas/dist/es/index.js	39 kB
packages/keypad-context/dist/es/index.js	760 B
packages/kmath/dist/es/index.js	86.9 kB
packages/math-input/dist/es/index.js	77.6 kB
packages/math-input/dist/es/strings.js	1.79 kB
packages/perseus-editor/dist/es/index.js	688 kB
packages/perseus-linter/dist/es/index.js	22.2 kB
packages/perseus-score/dist/es/index.js	115 kB
packages/perseus/dist/es/strings.js	6.02 kB
packages/pure-markdown/dist/es/index.js	3.66 kB
packages/simple-markdown/dist/es/index.js	12.5 kB

_{compressed-size-action}

[Myranae]

Looks good, but it reminded me of this ticket that hasn't been done yet related to the correct field. I don't think that actually affects us at all, but I remember that the correct field was frequently used as the source of information for various graphs. Do you know if that's still the case? I don't think we need to take that into account here, but it would be more important for when we hook this up.

[benchristel]

@Myranae I don't think the issue described in that ticket will come into play for SSS. We're removing the entire correct field from the options, so its internal structure doesn't really matter for our purposes.

[Myranae]

Looks good! From what I can remember, correct was sometimes used in place of graph to render the graphs, so might need to look into that before hooking these functions up. Created a follow-up ticket.

[benchristel]

Oh! Are you talking about static mode? That's going to be an issue for several widgets, not just interactive graph. I know Radio has a static mode too.

Since the static field is on the WidgetOptions type, which is common to all widgets, what I imagine we'll do is something like this during publish:

function getPublicWidgetData<W extends WidgetOptions<any, any>>(widget: W): W {
    // Don't remove the answers from static widgets. Static widgets are not
    // interactive; instead they alwats display the correct answer.
    if (widget.static) {
        return widget;
    }

    // Remove answers and hints from non-static widgets.
    const publicOptions = getWidgetExport(widget.type)
        .getPublicWidgetOptions(widget.options);
    
    return {
        ...widget,
        options: publicOptions,
    };
}

[jeremywiebe]

Sorry, I'm late to this PR...

Should we have one more test here for static: true? When that's the case, we need to keep the correct field as that's used in the render:

perseus/packages/perseus/src/widgets/interactive-graphs/stateful-mafs-graph.tsx

Line 136 in 9cabe68

state={initializeGraphState({...props, graph: props.correct})}

[benchristel]

The static field doesn't exist on PerseusInteractiveGraphWidgetOptions, only WidgetOptions, so we'll have to do this check elsewhere as in my comment above. The static field on WidgetOptions is passed to each widget by the renderer:

perseus/packages/perseus/src/renderer.tsx

Line 588 in b07f293

static: widgetInfo?.static,

.

[jeremywiebe]

🤦‍♂️ Yikes, sorry! I totally missed the comments above relating to this already! I switched straight to the file changes and didn't see them.